/*
 * Copyright:  2018 smarabbit studio.
 *
 *  Licensed under the Confluent Community License; you may not use this file
 *  except in compliance with the License.  You may obtain a copy of the License at
 *
 *  http://www.confluent.io/confluent-community-license
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *  WARRANTIES OF ANY KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations under the License.
 *
 *  @作   者： 黄开晖 (117227773@qq.com)
 *  @日   期:  2021年5月23日
 */
package com.massyframework.beanskin.assembly.beans;

import java.lang.annotation.Annotation;
import java.util.List;
import java.util.Map;

/**
 * {@link BeanContextAdapter}, 适配各种bean容器。
 * 
 * <p>
 * {@link BeanContextAdapter}的目的不是管理Bean，这些工作将由具体的Bean容器负责，<br>
 * 它仅仅只关心为需要被外部使用的Bean提供统一的访问方法，要求这些bean具备唯一的beanName。<br>
 * 需要被外部使用的Bean包括：
 * <ul>
 *     <li>作为输出服务的Bean</li>
 *     <li>可被外部装配件定位和查找的bean</li>
 * </ul>
 * 部分Bean容器未必会给所有管理的Bean设置名称，如果Bean可能会被外部使用，请为其配置唯一的beanName.
 * @author  Huangkaihui
 *
 */
public interface BeanContextAdapter {

	/**
     * 判断{@code beanName}的Bean是否存在
     * @param beanName {@link String}, bean名称
     * @return {@link boolean}, 返回<code>true</code>表示存在，返回<code>false</code>表示不存在。
     */
    boolean containsBean(String beanName);

    /**
     * 根据{@code beanName}获取Bean实例
     * @param beanName {@link String}, bean名称
     * @return {@link Object}
     * @throws BeanNotFoundException 未找到Bean时抛出例外
     */
    Object getBean(String beanName) throws BeanNotFoundException;
    
    /**
     * 根据{@code beanName}获取bean类型
     * @param beanName {@link String}, bean名称
     * @return {@link Class}
     * @throws BeanNotFoundException 未找到Bean时抛出例外
     */
    Class<?> getBeanType(String beanName) throws BeanNotFoundException;

    /**
     * 根据{@code beanName}获取Bean实例, 并按指定类型返回.<br>
     * 本方法将beanType类型名作为俄beanName, 直接调用{@link #getBean(String, Class)}处理，
     * @param beanType {@link Class}, 指定的返回类型
     * @param <B>
     * @return {@link B}
     * @throws BeanNotFoundException 未找到Bean时抛出例外
     */
    default <B> B getBean(Class<B> beanType) throws BeanNotFoundException{
        return this.getBean(beanType.getName(), beanType);
    }

    /**
     * 根据{@code beanName}获取Bean实例, 并按指定类型返回
     * @param beanName {@link String}, bean名称
     * @param beanType {@link Class}, 指定的返回类型
     * @param <B>
     * @return {@link B}
     * @throws BeanNotFoundException 未找到Bean时抛出例外
     */
    default <B> B getBean(String beanName, Class<B> beanType) throws BeanNotFoundException{
        Object result = this.getBean(beanName);
        return beanType.cast(result);
    }

    /**
     * 获取所有派生于{@code beanType}的实例<br>
     * @param beanType {@link Class}, bean实现的类型
     * @return {@link Map}
     */
    <B> Map<String, B> getBeansOfType(Class<B> beanType);

    /**
     * 获取所有在类上注解{@code annoType}的bean实例
     * @param annoType {@link Class}.注解类型。
     * @return {@link Map}
     */
    Map<String, Object> getBeansWithAnnotation(Class<? extends Annotation> annoType);
    
    /**
     * bean名称列表 
     * @return {@link List}
     */
    List<String> getBeanNames();
}
